﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Item Information </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Item Information ">
    <meta name="generator" content="docfx 2.59.2.0">
    
    <link rel="shortcut icon" href="../../favicon.ico">
    <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../styles/docfx.css">
    <link rel="stylesheet" href="../../styles/main.css">
    <link rel="stylesheet" href="../../styles/socialbar.css">
    <link rel="stylesheet" href="../../styles/header.css">
    <link rel="stylesheet" href="../../styles/version.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto:400,100,300,500,700,100italic,300italic,400italic" rel="stylesheet" type="text/css">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
    <meta property="docfx:navrel" content="../../toc.html">
    <meta property="docfx:tocrel" content="../toc.html">
    <meta property="docfx:uid" content="doc-restapi-Item-Information">
    
    <meta property="docfx:rel" content="../../">
    
    <script type="text/javascript" src="../../nav.js"></script>
    <script type="text/javascript" src="../toc.js"></script>
  
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <div class="mb-socials-heading" style="height: 40px;">
        	<div class="mb-socials-heading-inner container">
        		<div class="mb-socials-heading-right">
        			<div class="mb-socials-list">
                          
        				<div class="mb-socials-item facebook">
        					<a class="mb-socials-item-link" target="_blank" href="https://facebook.com/embyapp"></a>
        					<div class="mb-socials-item-popup">
        						<span>Facebook</span>
        					</div>
        				</div><div class="mb-socials-item twitter">
        					<a class="mb-socials-item-link" target="_blank" href="https://twitter.com/embyapp"></a>
        					<div class="mb-socials-item-popup">
        						<span>Twitter</span>
        					</div>
        				</div>
        				<div class="mb-socials-item pinterest">
        					<a class="mb-socials-item-link" target="_blank" href="https://www.pinterest.com/emby0240/emby-news/"></a>
        					<div class="mb-socials-item-popup">
        						<span>Pinterest</span>
        					</div>
        				</div>
        				<div class="mb-socials-item tumblr">
        					<a class="mb-socials-item-link" target="_blank" href="https://embyapp.tumblr.com/"></a>
        					<div class="mb-socials-item-popup">
        						<span>Tumblr</span>
        					</div>
        				</div>
        				<div class="mb-socials-item github">
        					<a class="mb-socials-item-link" target="_blank" href="https://github.com/MediaBrowser"></a>
        					<div class="mb-socials-item-popup">
        						<span>GitHub</span>
        					</div>
        				</div><div class="mb-socials-item rss">
        					<a class="mb-socials-item-link" target="_blank" href="https://emby.media/blog.xml"></a>
        					<div class="mb-socials-item-popup">
        						<span>RSS</span>
        					</div>
        				</div>
                          
        			</div>
        		</div>
        	</div>
        </div>
        <div class="container">
        	<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
        		  
        		  <a class="navbar-brand" href="../../index.html">
        		    <img id="logo" class="svg" src="../../images/emby_dev_logo.png" alt="">
        		  </a>
        		  <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
        			<span class="sr-only">Toggle navigation</span>
        			<span class="icon-bar"></span>
        			<span class="icon-bar"></span>
        			<span class="icon-bar"></span>
        		  </button>
        		<div class="collapse navbar-collapse" id="navbar">
        			
        			<ul class="nav level1 navbar-nav">
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../index.html" title="DEV Home">DEV Home</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../doc/index.html" title="Documentation">Documentation</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../reference/index.html" title="Reference">Reference</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../download/index.html" title="Download">Download</a>
        			      </li>
        			</ul>		</div>
        	</nav>
        </div>
        <div class="nav-overlay d-none"></div>        
        <div class="subnav navbar navbar-default">
          <div class="container">
            <div class="hide-when-search" id="breadcrumb">
        	  <ul class="breadcrumb">
        		<li></li>
        	  </ul>
        	</div>
        
        	<div class="breadcrumpsearch">
        	  <form class="navbar-form navbar-right" role="search" id="search">
        		<div class="form-group">
        		  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
        		</div>
        	  </form>
        	</div>
          </div>
        </div>
      </header>
      <div class="container body-content">
        
        <div id="search-results">
          <div class="search-list">Search Results for <span></span></div>
          <div class="sr-items">
            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
          </div>
          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
        </div>
      </div>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="doc-restapi-Item-Information">
<h1 id="item-information">Item Information</h1>

<p>Library items have a number of interesting properties. Among these are, but not limited to:</p>
<ul>
<li>Name</li>
<li>Id</li>
<li>CriticRating</li>
<li>CriticRatingSummary</li>
<li>DateCreated</li>
<li>GameSystem</li>
<li>GenreItems - Request this field via Genres</li>
<li>HomePageUrl</li>
<li>IsHD</li>
<li>Language</li>
<li>Overview</li>
<li>ParentId</li>
<li>Path</li>
<li>People</li>
<li>Players</li>
<li>ProductionYear</li>
<li>RunTimeTicks</li>
<li>SeasonCount</li>
<li>SortName</li>
<li>Studios</li>
<li>Taglines</li>
<li>Tags</li>
<li>Type</li>
</ul>
<p>See also: <a class="xref" href="../../reference/pluginapi/MediaBrowser.Model.Dto.BaseItemDto.html">BaseItemDto</a></p>
<p>When retrieving a single item, the entire object is returned. When querying for items, the return data will be stripped to include only a minimal amount of information. When querying, you can configure the fields that are returned in the output. See <a href="Browsing-the-Library.html">browsing the Library.</a></p>
<p>Here are some other properties along with their descriptions:</p>
<h3 id="airdays-airtime-status">AirDays, AirTime, Status</h3>
<p>These are applicable to Series only and will give you information about when episodes air.</p>
<h3 id="album-albumartist-artists-albumid-albumprimaryimagetag">Album, AlbumArtist, Artists, AlbumId, AlbumPrimaryImageTag</h3>
<p>These are applicable to audio files and music albums only.</p>
<h3 id="aspectratio">AspectRatio</h3>
<p>This is generally the original aspect ratio that the video was filmed in. The actual aspect ratio of the user's video can be found in the MediaStreams property.</p>
<h3 id="backdropimagetags">BackdropImageTags</h3>
<p>This will tell you how many backdrop images are available for an item. See <a href="Images.html">images</a>.</p>
<h3 id="chapters">Chapters</h3>
<p>This is applicable to videos only. This will give you the list of chapter markers contained within the video.</p>
<h3 id="childcount">ChildCount</h3>
<p>For folders, this indicates the number of child items available.</p>
<h3 id="communityrating">CommunityRating</h3>
<p>This is the Imdb, Tmdb, or Tvdb rating of the item. At this time we do not have the ability to identify the source.</p>
<h3 id="cumulativeruntimeticks">CumulativeRunTimeTicks</h3>
<p>For folders, this represents the cumulative runtime.</p>
<h3 id="enddate">EndDate</h3>
<p>This is the date an item ended. For Persons this represents death date. For series that have ended, this is the air date of the final episode.</p>
<h3 id="genreitems">GenreItems</h3>
<p>This is a list of Name/Id pairs of genres. To request this field, request Genres.</p>
<h3 id="imagetags">ImageTags</h3>
<p>This will tell you what images are available for an item. See <a href="Images.html">images</a>.</p>
<h3 id="indexnumber">IndexNumber</h3>
<p>This serves different purposes depending on the type of item. For episodes this is the episode number. For seasons, this is the season number. For audio files, this is the track number.</p>
<h3 id="indexnumberend">IndexNumberEnd</h3>
<p>Denotes the ending index number, in case a file spans multiple episodes.</p>
<h3 id="isfolder">IsFolder</h3>
<p>This will tell you if the item is a media item, or if it's a folder containing other items. When navigating to an item, this will allow you to determine what type of display to present.</p>
<h3 id="mediatype">MediaType</h3>
<p>If an item is a media item, this will tell you what kind of media it is so that you can customize your display. The core has three known media types: Audio, Video, Game. Plugins may provide others.</p>
<h3 id="type">Type</h3>
<p>This will tell you the exact object type of the item, in case you would like to customize further. For example, the Video media type has several implementations - Movie, Episode, Trailer, etc. Folder also has several - Series, Season, BoxSet, MusicArtist, MusicAlbum, etc.</p>
<h3 id="isotype">IsoType</h3>
<p>This setting is applicable to videos only. If a video is an Iso this will give you the type - Dvd or BluRay.</p>
<h3 id="localtrailercount-remotetrailers">LocalTrailerCount, RemoteTrailers</h3>
<p>LocalTrailerCount is the number of downloaded local trailers that are available for an item. The actual trailer items can be retrieved separately using /Users/{UserId}/Items/{Id}/LocalTrailers.</p>
<p>RemoteTrailers are a list of known online trailers. When supporting trailers, precedence should be given to downloaded trailers. It is up the client developer as to whether or not they just want to pick one, or present all of them in a list. The most common scenario is that the user will have just one local trailer.</p>
<h3 id="locationtype">LocationType</h3>
<p>This indicates if the item is a file system item, remote, or virtual.</p>
<p>FileSystem items are items the user has physical copies of on their file system. Remote items point to a url address. Virtual items entirely virtual and are not playable (e.g. missing episodes).</p>
<h3 id="mediasources">MediaSources</h3>
<p>Contains raw media information about the available media sources for this library item.</p>
<h3 id="mediastreams">MediaStreams</h3>
<p>This is applicable to Audio and Video only. This will provide detailed information about the audio, video and subtitle tracks embedded within the file. <strong>Note:</strong> This has now been superseded by MediaSources. Going forward MediaStreams should only be used for display purposes.</p>
<h3 id="officialrating">OfficialRating</h3>
<p>G, PG-13, R, TV-MA, etc.</p>
<h3 id="overviewhtml">OverviewHtml</h3>
<p>An html version of the overview, possibly with links embedded.</p>
<h3 id="parentindexnumber">ParentIndexNumber</h3>
<p>Similiar to IndexNumber, this serves different purposes depending on the type of item. For episodes this is the season number. For audio files, this is the disc number.</p>
<h3 id="parentartitemid-parentartimagetag-parentlogoitemid-parentlogoimagetag-parentbackdropitemid-parentbackdropimagetags">ParentArtItemId, ParentArtImageTag, ParentLogoItemId, ParentLogoImageTag, ParentBackdropItemId, ParentBackdropImageTags</h3>
<p>See <a href="Images.html">Images</a></p>
<p>If an item does not have it's own art, backdrop or logo, these properties will contain information about parent items with those images in order to allow inheritance.</p>
<h3 id="partcount">PartCount</h3>
<p>For multi-file videos this will indicate the number of parts.</p>
<h3 id="people">People</h3>
<p>These are the people involved in the item. Each person has Name, Role, Type and PrimaryImageTag properties.</p>
<h3 id="playedpercentage">PlayedPercentage</h3>
<p>This is populated for folders to indicate the user's cumulative progress through all items in the folder.</p>
<h3 id="premieredate">PremiereDate</h3>
<p>This serves different purposes depending on the type of item. For episodes and series, this is the first air date. For movies, albums and songs, this is the release date. For persons this is date of birth. For artists, this is their formation date.</p>
<h3 id="originalprimaryimageaspectratio-primaryimageaspectratio">OriginalPrimaryImageAspectRatio, PrimaryImageAspectRatio</h3>
<p>This is the aspect ratio of the primary image. Most image types have a predictable aspect ratio, but primary is the one exception. A typical use case when rendering a list of items is to determine the average AR, and then display them all using that value.</p>
<p>OriginalPrimaryImageAspectRatio ratio is the AR of the original image file. PrimaryImageAspectRatio is the AR after image enhancers have been applied (e.g. Cover Art).</p>
<p>See <a href="Images.html">Images</a></p>
<h3 id="productionlocations">ProductionLocations</h3>
<p>This is a list of strings indicating filming locations. For Persons, this will have one entry and will contain their place of birth.</p>
<h3 id="providerids">ProviderIds</h3>
<p>This is a dictionary of provider id's for an item - Tmdb, Tvdb, TvCom, etc.</p>
<p>A list of known provider id's can be found <a href="https://github.com/MediaBrowser/MediaBrowser/blob/master/MediaBrowser.Model/Entities/MetadataProviders.cs">here</a>, although plugins can inject additional ones.</p>
<h3 id="recursiveitemcount">RecursiveItemCount</h3>
<p>For folders, this indicates the number of items available, recursively.</p>
<h3 id="recursiveunplayeditemcount">RecursiveUnplayedItemCount</h3>
<p>For folders, this indicates the number of unplayed items available, recursively.</p>
<h3 id="seriesid-seriesname">SeriesId, SeriesName</h3>
<p>These properties are applicable only to Episodes and Seasons. This will give you some basic information about the TV Series.</p>
<h3 id="specialfeaturecount">SpecialFeatureCount</h3>
<p>This is applicable to Movies and Series only. This will tell you how many special features are available. The actual special feature items can then be retrieved using /Users/{UserId}/Items/{Id}/SpecialFeatures.</p>
<h3 id="userdata">UserData</h3>
<p>Contains user state for an item, such as personal rating and playstate.</p>
<h3 id="video3dformat">Video3DFormat</h3>
<p>The 3D format, if applicable.</p>
<h3 id="videotype">VideoType</h3>
<p>This is applicable to Videos only. This will give you the type of video - VideoFile, Bluray, Dvd, HdDvd, Iso.</p>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <div class="sdkversion Release">
                  SDK <span class="sdkVersionSpan"></span>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>On this Page</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to Top</a>
            </span>
            Copyright 2022 © EMBY LLC.  Please see our <a class="lnk" href="https://emby.media/terms.html">terms of use</a> and <a class="lnk" href="https://emby.media/privacy.html">privacy policy</a>.
            
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../../searchIndex.js"></script>
    <script type="text/javascript" src="../../styles/lunr.min.js"></script>
    <script type="text/javascript" src="../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../styles/main.js"></script>
  </body>
</html>
